/*
 * Original Author -> Harry Yang (taketoday@foxmail.com) https://taketoday.cn
 * Copyright © TODAY & 2017 - 2022 All Rights Reserved.
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see [http://www.gnu.org/licenses/]
 */

package cn.taketoday.framework.web.servlet;

/**
 * Enumeration of filter dispatcher types, identical to
 * {@link jakarta.servlet.DispatcherType} and used in configuration as the servlet API may
 * not be present.
 *
 * @author Stephane Nicoll
 * @since 4.0
 */
public enum DispatcherType {

  /**
   * Apply the filter on "RequestDispatcher.forward()" calls.
   */
  FORWARD,

  /**
   * Apply the filter on "RequestDispatcher.include()" calls.
   */
  INCLUDE,

  /**
   * Apply the filter on ordinary client calls.
   */
  REQUEST,

  /**
   * Apply the filter under calls dispatched from an AsyncContext.
   */
  ASYNC,

  /**
   * Apply the filter when an error is handled.
   */
  ERROR

}
